The wrap-ansi npm package is used to wrap words to a specified column width without breaking ANSI escape codes. This is particularly useful for formatting command-line output that includes color or other special styles.
Word wrapping
This feature allows you to wrap a string to a specified width. In the code sample, the input string is wrapped so that each line does not exceed 20 characters.
const wrapAnsi = require('wrap-ansi');
const input = 'The quick brown fox jumps over the lazy dog';
const output = wrapAnsi(input, 20);
console.log(output);Respecting ANSI escape codes
This feature ensures that ANSI escape codes are not broken when the text is wrapped. The code sample demonstrates wrapping text that includes ANSI escape codes for red text.
const wrapAnsi = require('wrap-ansi');
const input = '\u001B[31mThe quick brown fox\u001B[39m jumps over the lazy dog';
const output = wrapAnsi(input, 20);
console.log(output);Hard wrapping
This feature allows for hard wrapping, which ensures that line breaks are inserted at exactly the specified column, even if it means breaking a word. The code sample shows how to use the 'hard' option to enforce strict column width.
const wrapAnsi = require('wrap-ansi');
const input = 'The quick brown \nfox jumps over the lazy dog';
const output = wrapAnsi(input, 20, { hard: true });
console.log(output);The cli-truncate package is similar to wrap-ansi in that it also deals with ANSI escape codes and string truncation in the terminal. However, cli-truncate focuses on truncating strings to a specified width without breaking the escape codes, rather than wrapping text to a new line.
Slice-ansi is another package that handles strings containing ANSI escape codes. It allows you to slice a string with ANSI escape codes, similar to how Array.prototype.slice works. Unlike wrap-ansi, it does not wrap text but rather extracts a substring without breaking the escape codes.
String-width is a package that can calculate the visual width of a string in the terminal, taking into account ANSI escape codes and double-width characters. It does not wrap or modify the string itself but can be used in conjunction with wrap-ansi to determine where to wrap a string.
Wordwrap a string with ANSI escape codes
$ npm install wrap-ansi
const chalk = require('chalk');
const wrapAnsi = require('wrap-ansi');
const input = 'The quick brown ' + chalk.red('fox jumped over ') +
'the lazy ' + chalk.green('dog and then ran away with the unicorn.');
console.log(wrapAnsi(input, 20));
Wrap words to the specified column width.
Type: string
String with ANSI escape codes. Like one styled by chalk. Newline characters will be normalized to \n.
Type: number
Number of columns to wrap the text to.
Type: object
Type: boolean
Default: false
By default the wrap is soft, meaning long words may extend past the column width. Setting this to true will make it hard wrap at the column width.
Type: boolean
Default: true
By default, an attempt is made to split words at spaces, ensuring that they don't extend past the configured columns. If wordWrap is false, each column will instead be completely filled splitting words as necessary.
Type: boolean
Default: true
Whitespace on all lines is removed by default. Set this option to false if you don't want to trim.
FAQs
Wordwrap a string with ANSI escape codes
We found that wrap-ansi demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 2 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.